Skip to main content
GET
/
fulfillment
/
{id}
Get fulfillment option
curl --request GET \
  --url https://api.example.com/fulfillment/{id}
{
  "data": {
    "id": "delivery",
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "organization_id": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
    "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
    "name": "Delivery",
    "type": "DELIVERY",
    "status": "ACTIVE"
  }
}
Returns a single fulfillment option for the authenticated merchant. Use this endpoint when you already know the external id and need the current name, type code, and status without listing all options.
Requires an access token with the fulfillment:read scope. See Authorize to obtain a token.

​
Request

Replace {id} with the external fulfillment identifier. 
curl "https://firespark.vercel.app/api/integrations/v1/fulfillment/delivery" \
  -H "Authorization: Bearer ACCESS_TOKEN"

​
Response

The response wraps one fulfillment object in data. 
{
  "data": {
    "id": "delivery",
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "organization_id": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
    "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
    "name": "Delivery",
    "type": "DELIVERY",
    "status": "ACTIVE"
  }
}

​
Path parameters

ParameterTypeDescription
idstringExternal fulfillment identifier. Alphanumeric characters, _, and - only. 1–64 characters. Unique per merchant.

​
Fulfillment object

FieldTypeDescription
idstringExternal fulfillment identifier. Matches the path parameter.
uidstring (UUID)Fire spark internal identifier.
organization_idstring (UUID)Organization that owns the merchant.
merchant_idstring (UUID)Merchant the fulfillment option belongs to.
namestringDisplay name. 1–100 characters.
typestringFulfillment type code. 1–100 characters. Common values: DELIVERY, PICKUP, DINE_IN. Custom codes are supported.
statusstringACTIVE or INACTIVE.

​
Error responses

StatusDescription
401Missing or invalid access token.
403Token does not include the fulfillment:read scope.
404No fulfillment option exists with the given id.